IAxis.Stop method

Commands a controlled motion stop and sets an axis to the Stopping state. It aborts any ongoing method execution. While an axis is in the Stopping state, other methods can't move the axis. After the axis has reached velocity zero, the Done property of IKsCommand is set to true immediately. To leave the Stopping state and go to Standstill, use IKsCommand.Abort.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

IStopCommand Stop(
       double deceleration,
       double jerk
)

Function Stop(
       deceleration As Double,
       jerk As Double
) As IStopCommand

Parameters

deceleration

Type: double

The value of the deceleration. The unit is determined by McProfileType. [unit/second²] or [second]

jerk

Type: double

The value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Return value

Type: IStopCommand

Returns the states of a stop.

Remarks

Make the axis decelerate at the specified speed until it stops.
This method is primarily intended for emergency stop or special cases.
If Deceleration = 0, the behavior of the method is implementation-specific.
Only Power and Abort can abort Stop.